Skip to main content

everai volume

Manage volume

Usage:

everai volume [-h] {create,list,ls,delete,get,pull,push,publish,tree,tr} ...

Commands:

  • create Create volume
  • list (ls) List volume
  • delete Delete volume
  • get Get volume
  • pull Pull volume
  • push Push volume
  • publish Publish volume to everyone
  • tree (tr) Tree volume

Options:

  • -h, --help show this help message and exit

everai volume create​

Create volume

Example:

everai volume create test-volume

Usage:

everai volume create [-h] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit

everai volume list (ls)​

List volume

Example:

everai volume list

The result could be shown like this, and CREATED_AT uses UTC time display.

NAME                                     REVISION    CREATED_AT                  FILES  SIZE          STATUS
---------------------------------------  ----------  ------------------------  -------  ------------  --------
get-start-volume                         000008-5d6  2024-05-28T12:46:09+0000        1  42 B          Private
test-start-volume                        000003-490  2024-06-24T02:04:19+0000        1  100 B         Private

Usage:

everai volume list [-h] [--output [OUTPUT]]

Options:

  • -h, --help show this help message and exit
  • --output [OUTPUT], -o [OUTPUT] Output format, One of: (json, yaml, table, wide)

everai volume delete​

Delete volume

Example:

everai volume delete get-start-volume --all

Usage:

everai volume delete [-h] [--local] [--cloud] [--all] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit
  • --local Delete the local cache of volume only
  • --cloud Delete the volume in cloud, and reserve local cache
  • --all Delete volume both cache and in-cloud

everai volume get​

Get volume

Example:

everai volume get get-start-volume

The result could be shown like this:

<Volume: id: hupa49MesPXwmhFSy9Ku44, name: get-start-volume, revision: 000001-b9c, files: 1, size: 11 B>
path: /home/<username>/.cache/everai/volumes/hupa49MesPXwmhFSy9Ku44

Usage:

everai volume get [-h] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit

everai volume pull​

Pull volume

Example:

everai volume pull get-start-volume

Usage:

everai volume pull [-h] [--force] [--sync] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit
  • --force Force pull remote volume file to local, if your volume local metadata revision equal remote volume revision, pull will stop, if add --force, pull will ignore revision compare
  • --sync Sync file form remote, if this file local have, but remote not exist, then this local file will be delete. notice: only use argument --force, --sync will come into effect

everai volume push​

Push volume

Example:

everai volume push get-start-volume

The terminal displays the files pushing process, and the output results are as follows:

Uploading ...ots/462165984030d82259a11f4367a4eed129e94a7b/model_index.json: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 609/609 [00:00<00:00, 1799.51B/s]
Uploading ...984030d82259a11f4367a4eed129e94a7b/text_encoder_2/config.json: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 575/575 [00:00<00:00, 2007.34B/s]
Uploading                                            files:   5%|███████▊                                                                                                                                        | 2/37 [00:01<00:21,  1.64file/s]
Uploading ...9a11f4367a4eed129e94a7b/text_encoder_2/model.fp16.safetensors:   0%|                                                                                                                                    | 0/1325.01 [00:00<?, ?MiB/s]

Usage:

everai volume push [-h] [-u] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit
  • -u, --update specifies that volumes push files only when the destination objects do not exist or when the size of the files is different from that of the destination objects

everai volume publish​

Publish volume to everyone

Example:

 everai volume publish demo-volume

After publishing the volume, run command everai volume list, the status is changed from Private to Public. CREATED_AT uses UTC time display.

NAME               REVISION    CREATED_AT                  FILES  SIZE    STATUS
-----------------  ----------  ------------------------  -------  ------  --------
demo-volume        000000-000  2024-05-10T06:10:25+0000        0  0 B     Public

Usage:

ever volume publish [-h] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit

everai volume tree​

Tree volume

Example:

everai volume tree get-start-volume

The result could be shown like this:

get-start-volume
└── my-model

Usage:

everai volume tree [-h] name

Positional arguments:

  • name The volume name

Options:

  • -h, --help show this help message and exit